<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.11"/>
<title>GrPPI: grppi::iteration_t&lt; Transformer, Predicate &gt; Class Template Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<script type="text/javascript">
  $(document).ready(function() { init_search(); });
</script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  <td id="projectlogo"><img alt="Logo" src="logo.svg"/></td>
  <td id="projectalign" style="padding-left: 0.5em;">
   <div id="projectname">GrPPI
   &#160;<span id="projectnumber">0.3.1</span>
   </div>
   <div id="projectbrief">Generic and Reusable Parallel Pattern Interface</div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.11 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
  <div id="navrow1" class="tabs">
    <ul class="tablist">
      <li><a href="index.html"><span>Main&#160;Page</span></a></li>
      <li><a href="pages.html"><span>Related&#160;Pages</span></a></li>
      <li><a href="modules.html"><span>Modules</span></a></li>
      <li><a href="namespaces.html"><span>Namespaces</span></a></li>
      <li class="current"><a href="annotated.html"><span>Classes</span></a></li>
      <li><a href="files.html"><span>Files</span></a></li>
      <li>
        <div id="MSearchBox" class="MSearchBoxInactive">
        <span class="left">
          <img id="MSearchSelect" src="search/mag_sel.png"
               onmouseover="return searchBox.OnSearchSelectShow()"
               onmouseout="return searchBox.OnSearchSelectHide()"
               alt=""/>
          <input type="text" id="MSearchField" value="Search" accesskey="S"
               onfocus="searchBox.OnSearchFieldFocus(true)" 
               onblur="searchBox.OnSearchFieldFocus(false)" 
               onkeyup="searchBox.OnSearchFieldChange(event)"/>
          </span><span class="right">
            <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
          </span>
        </div>
      </li>
    </ul>
  </div>
  <div id="navrow2" class="tabs2">
    <ul class="tablist">
      <li><a href="annotated.html"><span>Class&#160;List</span></a></li>
      <li><a href="classes.html"><span>Class&#160;Index</span></a></li>
      <li><a href="inherits.html"><span>Class&#160;Hierarchy</span></a></li>
      <li><a href="functions.html"><span>Class&#160;Members</span></a></li>
    </ul>
  </div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
     onmouseover="return searchBox.OnSearchSelectShow()"
     onmouseout="return searchBox.OnSearchSelectHide()"
     onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0" 
        name="MSearchResults" id="MSearchResults">
</iframe>
</div>

<div id="nav-path" class="navpath">
  <ul>
<li class="navelem"><a class="el" href="namespacegrppi.html">grppi</a></li><li class="navelem"><a class="el" href="classgrppi_1_1iteration__t.html">iteration_t</a></li>  </ul>
</div>
</div><!-- top -->
<div class="header">
  <div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="classgrppi_1_1iteration__t-members.html">List of all members</a>  </div>
  <div class="headertitle">
<div class="title">grppi::iteration_t&lt; Transformer, Predicate &gt; Class Template Reference</div>  </div>
</div><!--header-->
<div class="contents">

<p>Representation of iteration pattern. Represents a iteration that can be used as a stage on a pipeline.  
 <a href="classgrppi_1_1iteration__t.html#details">More...</a></p>

<p><code>#include &lt;<a class="el" href="iteration__pattern_8h_source.html">iteration_pattern.h</a>&gt;</code></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:ac4d43f9d18a3681a35c7e7d135b9aaa9"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgrppi_1_1iteration__t.html#ac4d43f9d18a3681a35c7e7d135b9aaa9">iteration_t</a> (Transformer &amp;&amp;t, Predicate &amp;&amp;p) noexcept</td></tr>
<tr class="memdesc:ac4d43f9d18a3681a35c7e7d135b9aaa9"><td class="mdescLeft">&#160;</td><td class="mdescRight">Constructs a iteration with a predicate.  <a href="#ac4d43f9d18a3681a35c7e7d135b9aaa9">More...</a><br /></td></tr>
<tr class="separator:ac4d43f9d18a3681a35c7e7d135b9aaa9"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a2159f9961a63d985f3f24aeb4c546281"><td class="memTemplParams" colspan="2">template&lt;typename Item &gt; </td></tr>
<tr class="memitem:a2159f9961a63d985f3f24aeb4c546281"><td class="memTemplItemLeft" align="right" valign="top">bool&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classgrppi_1_1iteration__t.html#a2159f9961a63d985f3f24aeb4c546281">predicate</a> (Item &amp;&amp;item) const </td></tr>
<tr class="memdesc:a2159f9961a63d985f3f24aeb4c546281"><td class="mdescLeft">&#160;</td><td class="mdescRight">Invokes the predicate of the iteration over a data item.  <a href="#a2159f9961a63d985f3f24aeb4c546281">More...</a><br /></td></tr>
<tr class="separator:a2159f9961a63d985f3f24aeb4c546281"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a7b8e05ea3447f3a87d8a16565accb831"><td class="memTemplParams" colspan="2">template&lt;typename Item &gt; </td></tr>
<tr class="memitem:a7b8e05ea3447f3a87d8a16565accb831"><td class="memTemplItemLeft" align="right" valign="top">auto&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classgrppi_1_1iteration__t.html#a7b8e05ea3447f3a87d8a16565accb831">transform</a> (Item &amp;&amp;item) const </td></tr>
<tr class="memdesc:a7b8e05ea3447f3a87d8a16565accb831"><td class="mdescLeft">&#160;</td><td class="mdescRight">Applies the transformation over a data item.  <a href="#a7b8e05ea3447f3a87d8a16565accb831">More...</a><br /></td></tr>
<tr class="separator:a7b8e05ea3447f3a87d8a16565accb831"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ac3cdb8516c252139d7bf61ee1ececeea"><td class="memTemplParams" colspan="2">template&lt;typename T &gt; </td></tr>
<tr class="memitem:ac3cdb8516c252139d7bf61ee1ececeea"><td class="memTemplItemLeft" align="right" valign="top">auto&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classgrppi_1_1iteration__t.html#ac3cdb8516c252139d7bf61ee1ececeea">operator()</a> (T &amp;&amp;item)</td></tr>
<tr class="memdesc:ac3cdb8516c252139d7bf61ee1ececeea"><td class="mdescLeft">&#160;</td><td class="mdescRight">Applies the transformation over a data item.  <a href="#ac3cdb8516c252139d7bf61ee1ececeea">More...</a><br /></td></tr>
<tr class="separator:ac3cdb8516c252139d7bf61ee1ececeea"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><h3>template&lt;typename Transformer, typename Predicate&gt;<br />
class grppi::iteration_t&lt; Transformer, Predicate &gt;</h3>

<p>Representation of iteration pattern. Represents a iteration that can be used as a stage on a pipeline. </p>
<dl class="tparams"><dt>Template Parameters</dt><dd>
  <table class="tparams">
    <tr><td class="paramname">Predicate</td><td>Callable type for the iteration predicate. </td></tr>
  </table>
  </dd>
</dl>
</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a class="anchor" id="ac4d43f9d18a3681a35c7e7d135b9aaa9"></a>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename Transformer , typename Predicate &gt; </div>
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="classgrppi_1_1iteration__t.html">grppi::iteration_t</a>&lt; Transformer, Predicate &gt;::<a class="el" href="classgrppi_1_1iteration__t.html">iteration_t</a> </td>
          <td>(</td>
          <td class="paramtype">Transformer &amp;&amp;&#160;</td>
          <td class="paramname"><em>t</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">Predicate &amp;&amp;&#160;</td>
          <td class="paramname"><em>p</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">noexcept</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Constructs a iteration with a predicate. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">p</td><td>Predicate for the iteration. </td></tr>
  </table>
  </dd>
</dl>

</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a class="anchor" id="ac3cdb8516c252139d7bf61ee1ececeea"></a>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename Transformer , typename Predicate &gt; </div>
<div class="memtemplate">
template&lt;typename T &gt; </div>
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">auto <a class="el" href="classgrppi_1_1iteration__t.html">grppi::iteration_t</a>&lt; Transformer, Predicate &gt;::operator() </td>
          <td>(</td>
          <td class="paramtype">T &amp;&amp;&#160;</td>
          <td class="paramname"><em>item</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Applies the transformation over a data item. </p>

</div>
</div>
<a class="anchor" id="a2159f9961a63d985f3f24aeb4c546281"></a>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename Transformer , typename Predicate &gt; </div>
<div class="memtemplate">
template&lt;typename Item &gt; </div>
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">bool <a class="el" href="classgrppi_1_1iteration__t.html">grppi::iteration_t</a>&lt; Transformer, Predicate &gt;::predicate </td>
          <td>(</td>
          <td class="paramtype">Item &amp;&amp;&#160;</td>
          <td class="paramname"><em>item</em></td><td>)</td>
          <td> const</td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Invokes the predicate of the iteration over a data item. </p>

</div>
</div>
<a class="anchor" id="a7b8e05ea3447f3a87d8a16565accb831"></a>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename Transformer , typename Predicate &gt; </div>
<div class="memtemplate">
template&lt;typename Item &gt; </div>
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">auto <a class="el" href="classgrppi_1_1iteration__t.html">grppi::iteration_t</a>&lt; Transformer, Predicate &gt;::transform </td>
          <td>(</td>
          <td class="paramtype">Item &amp;&amp;&#160;</td>
          <td class="paramname"><em>item</em></td><td>)</td>
          <td> const</td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Applies the transformation over a data item. </p>

</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="iteration__pattern_8h_source.html">iteration_pattern.h</a></li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.11
</small></address>
</body>
</html>
